<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Fence</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: Fence</h1>

    




<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>Fence<span class="signature">(points, minZ, maxZ, parameters)</span><span class="type-signature"></span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    

    
    <h4 class="name" id="Fence"><span class="type-signature"></span>new Fence<span class="signature">(points, minZ, maxZ, parameters)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    围栏类
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            
            </td>

            

            

            <td class="description last">[{x:0, y:0},{x:12, y:12}, {x:24, y:0}, {x:0, y:0}] 围栏底面的路径信息，注意该数组第一个和最后一个元素坐标必须相同才能构封闭的多边形。且元素长度至少为4</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>minZ</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxZ</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>parameters</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            

            

            <td class="description last">parameters = {colorHex: 0x121223, opacity: 0.8, disableBottomPlane: false, disableTopPlane: true };
<br> colorHex: 16进制数表示的颜色   opacity代表透明度,1表示不透明，介于0-1之间表示透明.  disableBottomPlane: false表示不禁用底面， true表示禁用面，即底面不显示。</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    
    <dt class="tag-author">Author:</dt>
    <dd class="tag-author">
        <ul>
            <li>Mao Weiqing</li>
        </ul>
    </dd>
    

    

    

    

    

    

    

    
</dl>




















    
    </div>

    

    

    

    

    

    

    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="remove"><span class="type-signature"></span>remove<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    移除围栏
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
            

    

    
    <h4 class="name" id="setVisibility"><span class="type-signature"></span>setVisibility<span class="signature">(enable)</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    设置围栏的显示和隐藏
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enable</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            
            </td>

            

            

            <td class="description last">false代表隐藏， true代表显示</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>




















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BimrunSceneModel.html">BimrunSceneModel</a></li><li><a href="EnvEffectsPlugin.html">EnvEffectsPlugin</a></li><li><a href="Fence.html">Fence</a></li><li><a href="HeatmapPlugin-Heatmap.html">Heatmap</a></li><li><a href="SpritePlugin-BimrunSprite.html">BimrunSprite</a></li><li><a href="SpritePlugin-SpriteContainer.html">SpriteContainer</a></li><li><a href="Viewer.html">Viewer</a></li><li><a href="WalkThroughPlugin.html">WalkThroughPlugin</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Events">Events</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Wed May 26 2021 13:42:33 GMT+0800 (中国标准时间)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>